home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 002 / bb645.arc / BB.DOC < prev    next >
Text File  |  1987-02-28  |  43KB  |  1,279 lines

  1.                 ██████████
  2.               ██████████████
  3.              ███ · ████ · ███
  4.               ██████████████
  5.               ██████  ██████
  6.                ████████████
  7.                  ████████
  8.                 ██││││││██
  9.                  ████████
  10.              ██▄          ▄██
  11.               ▀██▄      ▄██▀
  12.                 ▀██▄  ▄██▀
  13.                   ▀████▀
  14.                   ▄████▄
  15.                 ▄██▀  ▀██▄
  16.               ▄██▀      ▀██▄
  17.              ██▀          ▀██
  18.  
  19.               ┌────────────┐
  20.               │ BLACKBEARD │
  21.               └────────────┘
  22.  
  23.               User Supported Software
  24.  
  25.  
  26.                VERSION LOG
  27.                BLACKBEARD
  28.  
  29. version  remarks
  30. ----------------------------------------------------------------
  31. pre-3.6  Pre release versions never distributed as user supported
  32.      software.  Avoid the use of these most have some bugs.
  33.  
  34.  3.6     First distributed release.  Works well.  Cutting past
  35.      the end of a line will lock up the computer (versions
  36.      3.6 - 4.6; fixed in 4.7 and above).
  37.  
  38.  3.7     Beta test version.  Avoid use.
  39.  
  40.  4.0     Virtual memory added.  File size limited by disk space.
  41.      Beta test version.  Avoid use.
  42.  
  43.  4.1     Keyboard remapping.  Beta test version.  Avoid use.
  44.  
  45.  4.2     Tab display.  Beta test version.  Avoid use.
  46.  
  47.  4.3     Pop-up directory to open wild card file names.  Beta
  48.      test version.  Avoid use.
  49.  
  50.  4.4     132 column mode for Everex card.  Adjustable virtual
  51.      memory limits.
  52.  
  53.  4.5     Limited release version.  Contains manual on disk.
  54.  
  55.  4.6     Improved manual.  Bug fix to pop-directory and switch to
  56.      file command.
  57.  
  58.  4.7     Official virtual memory release version.  (12-16-85)
  59.  
  60.  4.71    Bug fix to delete_line routine.
  61.  
  62.  4.72    Repeat key feature added.
  63.  
  64.  4.73    Recognize video mode after exit to DOS (12-18-85)
  65.  
  66.  4.74    Fixed Bug reading EOF terminated files.  Improved Repeat
  67.      Key and Keystroke Macro interaction.
  68.  
  69.  5.00    Memory Resident Version (Preliminary)
  70.  
  71.  5.10    First somewhat available memory resident version.
  72.  
  73.  5.12    Better file reading, so file date isn't always updated.
  74.      Files can be used with "make."
  75.  
  76.  5.13    New paragraph adjust for "bulleted" paragraphs.
  77.  
  78.  5.14    DOS window bug fix that didn't display last line when
  79.      kill buffer overflowed.
  80.  
  81.  5.15    Bug fix in pop-up directory and select window (αF6)
  82.      command interaction.
  83.  
  84.  5.16    Bug fix in non CRLF EOF terminated files.
  85.  
  86.  5.17    Improved adjust paragraph routines.
  87.  
  88.  5.18    Sound (beeps) for error messages.
  89.  
  90.  5.19    Pop-up Blackbeard "warm" (α=) or "cold" (α-); Bug fix to
  91.      insert number routine (bug entered around version 5.17).
  92.  
  93.  5.20    Conditional search & replace requires Y to replace.
  94.  
  95.  5.21    Bug fix to finding files under version PC-DOS 3.0 and
  96.      some versions of MS-DOS 2.11 (Other DOS versions appear
  97.      to work ok).  Bug fix to LF ^Z terminated files.  Escape
  98.      to exit search and filename prompt.  "cold" start
  99.      resets "everything." Improved search to avoid writing
  100.      when no changes have been made.  (4-1-86)
  101.  
  102. 5.22     Improved read/write file movement.  Check for valid
  103.      reentrant points before "popping-up" resident
  104.      Blackbeard (beep).  ("Random bugs" - avoid use)
  105.  
  106. 5.30     "Random bugs" exterminated.  First dumb terminal
  107.      emulator (to be expanded in subsequent versions).
  108.  
  109. 5.31     Infinite beep bug fixed.  Resident Abort (αZ) editing
  110.      "eof" bug fixed.
  111.  
  112. 5.32     Dumb terminal bug fixed.
  113.  
  114. 5.33     Infinite beep bug fixed (again).  Larger Memory
  115.      Requirements about 148K.  Find & Replace bug when
  116.      performed after end of file fixed.  Avoids running DOS
  117.      commands when resident to avoid system lockup.
  118.  
  119. 5.34     Better EOF checking! Permits ^Z in the middle of lines
  120.      in the middle of files.  Lines greater than 254
  121.      characters detected and editing aborted.  Insert number
  122.      does insert/replace number depending upon insert/replace
  123.      mode toggle.  Delete word modified to delete only next
  124.      punctuation of next alphanumerics, note: does not delete
  125.      next word as defined by word right.
  126.  
  127. 5.40     Even better EOF checking (lines not EOF terminated
  128.      properly do not display last two characters -- this bug
  129.      cannot be fixed) Fixed bug in automatic backup that
  130.      caused no automatic backups to be made.  Changed delete
  131.      word to match word right.
  132.  
  133. 5.41     =xxxxx works correctly again.  Reading file for CR LF
  134.      no ^Z terminated files works correctly.
  135.  
  136. 5.42     Minor EOF check fixes ; non-official release
  137.  
  138. 6.0      Expanded code size (C medium model).
  139.  
  140. 6.1      Backup up file (non-catastrophic) bug fix
  141.  
  142. 6.2      Prompt line editing using arrows, backspace, Home, End
  143.      Up arrow (to retrieve previous data), Ins and Del.
  144.      Better Ctrl-C trapping.  αJ is "EMACS" style "return" --
  145.      break line and go to start of next line.
  146.  
  147. 6.3      Fixed bug in adjust_paragraph when display tabs and
  148.      justify options are on.  Also checks for period and
  149.      makes sure there are two or more spaces after a period.
  150.      Available: July 4, 1986.
  151.  
  152. 6.4      Bug fix so case insensitive search works.  Also somewhat
  153.      faster (!?)
  154.  
  155. 6.41     Bug fix to searching!? Should make it healthier.  Tended
  156.      to disrupt cut & paste.
  157.  
  158. 6.42     Bug fix to "left word".
  159.      Nicer search and replace displays.
  160.      Fixed possible bug in read/write virtual memory buffer
  161.      (I have never seen this bug occur, but it is
  162.      theoretically possible)
  163.      Insert file function
  164.      Reverse Search & Repeat Reverse Search
  165.  
  166. 6.43     Goto start marker
  167.  
  168. 6.44     Insert file and Switch to window with deleted file;
  169.      works correctly now.
  170.  
  171. 6.45     Fix includes misc bugs, including mystery file scrambling
  172.      problem (the Bullendonk-Cooper bug).
  173.  
  174.  
  175. INTRODUCTION
  176.  
  177.    Blackbeard is designed to be a programmer's editor.  It
  178. performs the editing tasks a programmer needs, in as fast and
  179. efficient manner as possible.  It works the way you expect it
  180. to.  The primary use for Blackbeard is for source code editing
  181. and it does all the things you would expect.  It also has some
  182. word processing features; these were used to create this
  183. documentation.
  184.  
  185. Distribution and Registration
  186.  
  187.    As you know software copyright violation is rampant.  This is
  188. why we have created Blackbeard.  Because Blackbeard is a superior
  189. text editor and available for free distribution, there should be
  190. little need to pirate copyrightted software to obtain advanced
  191. text editing features.  Please feel free to give Blackbeard to
  192. your friends.  We are counting on you as a participant in the
  193. largest distribution network in the nation (the owners and users
  194. of PCs) to make Blackbeard a popular product.  With strong user
  195. support, Blackbeard will be enhanced with new features and
  196. capabilities making it the editor of choice.
  197.  
  198.    For fifteen (15) dollars you can become a registered owner of
  199. Blackbeard.  For your $15.00 you will appease your conscience
  200. about using unregistered software, provide support for future
  201. enhancements, receive a distinctive "Blackbeard" collectable, a
  202. registration sticker, and a copy of the latest version of
  203. Blackbeard.  The file FORM.TXT can be used as an order form.
  204. California state residents please add 6% state tax (90 cents)
  205. for a total of $15.90.
  206.  
  207.          SEND A CHECK MADE OUT TO BLACKBEARD TO:
  208.  
  209.         Blackbeard
  210.         1198 E. Baseline St.  Suite 113
  211.         San Bernardino, California  92410
  212.  
  213.  
  214.          We thank you for your support.
  215.  
  216. DOCUMENTATION
  217.  
  218.    Blackbeard does not come with a voluminous manual.  The design
  219. team decided early on that a good editor should not need a large
  220. reference manual; most of the documentation is built in.  This
  221. explans the more complex features of Blackbeard.
  222.  
  223.    The Blackbeard diskette should have the following files:
  224.  
  225.      File              Description
  226.      -------------------------------------------------------
  227.      bb.exe            This is the Blackbeard program.
  228.  
  229.      bb132.exe         This is the Blackbeard program set up
  230.                to run in 25 row by 132 column mode on
  231.                the Everex edge and genoa card.  (NO LONGER
  232.                CONTAINED ON THE BLACKBEARD DISTRIBUTION DISKETTE.
  233.                AVAILABLE ONLY UPON REQUEST).
  234.  
  235.      bb44.exe          This is the Blackbeard program set up
  236.                to run in 44 row by 132 column mode on
  237.                the Everex edge and genoa card.  (NO LONGER
  238.                CONTAINED ON THE BLACKBEARD DISTRIBUTION DISKETTE.
  239.                AVAILABLE ONLY UPON REQUEST).
  240.  
  241.      bbc.exe           Blackbeard key binding compiler
  242.  
  243.      bbf.exe           Blackbeard text formatter.  See
  244.                BBF.DOC instructions.  Turns
  245.                Blackbeard into a full-featured word
  246.                processor.
  247.  
  248.      bb.cfg            Blackbeard configuration file
  249.  
  250.      bb.key            Blackbeard key binding file compiled
  251.  
  252.      read.me           Blackbeard release notes
  253.  
  254.      bb.doc            Blackbeard manual
  255.  
  256.      bbkeys.txt        Blackbeard key binding file ready for
  257.                compilation.
  258.  
  259.      m_bb.msc          Blackbeard Mouse systems button and
  260.                movement defintion file
  261.  
  262.      m_bb.com          Blackbeard Mouse systems compiled menu
  263.                file.
  264.  
  265.      form.txt          Blackbeard order form.
  266.  
  267. SETTING UP AND RUNNING BLACKBEARD
  268.  
  269. Running Blackbeard
  270.  
  271.    To run Blackbeard type:
  272.  
  273.       BB
  274.  
  275.    The screen will be cleared and the Blackbeard information will
  276. appear with a request for a filename at the last line of the
  277. screen.  If you press enter a directory of file will be displayed
  278. from which you may select a file to edit (see the menus section
  279. for how to use menus). See the "Memory Residence" section on having
  280. Blackbeard installed as a "pop-up" editor.
  281.  
  282.    You can give Blackbeard a filename upon startup:
  283.  
  284.       BB <filename>
  285.  
  286.    Blackbeard will then display your file.
  287.  
  288. Status Line
  289.  
  290.    The last line line of the screen is reserved for the status
  291. information.  It looks like:
  292.  
  293. Line   1  Col    0  <DMIWSTN> Kill     0 Paste     0 C:\filename 846
  294.  
  295.    This is called the status line.  It tells you the line and
  296. column you are working on.  The letter inside brackets indicate
  297. the current editing settings.  The possible letters and meanings
  298. are described in the following chart:
  299.  
  300. Letter   Meaning
  301.    D     Drawing mode on
  302.    M     Keystroke macro recording on
  303.    I     Insert mode on
  304.    W     Word wrap on
  305.    B     Bullet mode on (and word wrap on)
  306.    S     Case sensitive search on
  307.    T     Auto-tab on
  308.    N     Auto-insert on
  309.  
  310. Kill followed by the size of the text in the delete buffer.
  311. Paste followed by the size of text in the paste buffer and the
  312. name of the file you are editing followed by its size.
  313.  
  314. Help and command menus
  315.  
  316.    To access the menus and learn the commands press the escape
  317. <Esc> key and the menu will pop-up.  You can execute a command or
  318. select any submenus by positioning the cursor on the item (using
  319. the keypad keys) and pressing the Enter key (<─┘).  To exit a
  320. menu without choosing an item press the escape key.  The menu
  321. action will be taken where the cursor was before you entered the
  322. menu.  With few exceptions the menu commands all have their
  323. direct keyboard counterparts which are described to the right of
  324. the English command description.  The direct commands use the
  325. keyboard letters and the shift () , Alt (α), and control (Ctrl)
  326. keys.  The following describes how they are shown:
  327.  
  328.      ^R - means Ctrl-R
  329.      R - means Shift-R
  330.      αR - means Alt-R
  331.  
  332.    The function keys are designated as F1 - F10.
  333.  
  334. Prompt Line
  335.  
  336.    Blackbeard will prompt you for various editing strings on
  337. the status line. This includes search/replace string; and new
  338. filename.  Blackbeard has a built in prompt line editor.  Prompt
  339. line editing can be performed using arrows, backspace, Home, End
  340. Up arrow (to retrieve previous data), Ins and Del. The Esc key
  341. is used to abort the prompt and enter to complete the prompt.
  342.  
  343. CONFIGURATION
  344.  
  345.    When Blackbeard starts up it looks for three files: the
  346. configuration file, the key binding file and the macro file.
  347.  
  348. Configuration File
  349.  
  350.    Blackbeard keeps a configuration file that allows you to
  351. customize the following areas:
  352.  
  353.       -  all items from the OPTIONS MENU
  354.       -  all items from the SETTINGS MENU
  355.       -  Window colors
  356.       -  WIndow sizes
  357.       -  the status line settings
  358.  
  359.    Blackbeard looks in the current subdirectory for a file named
  360. BB.CFG.  This file will be used to set the configuration
  361. setttings.  If there is not a file named BB.CFG in the current
  362. subdirectory, Blackbeard will look in the DOS environment for the
  363. symbol BBCFG, if it is found it will use the filename supplied
  364. with the symbol.  This will let you keep one configuration file
  365. and use Blackbeard from any disk or directory.
  366.  
  367.    To set BBCFG place this command or one similar in your
  368. autoexec.bat file
  369.  
  370.      SET BBCFG=C:\BB.CFG
  371.  
  372.    See the OPTIONS/SETTINGS menu for the read and save
  373. configuration commands.  These commands will request a filename
  374. and default to the current path and BB.CFG filename if none is
  375. given.
  376.  
  377. Macro file
  378.  
  379.    Blackbeard allows you to define and save keyboard macros.
  380. Blackbeard looks in the current subdirectory for a file named
  381. BB.MAC.  This file will be used to read in your macros.  If there
  382. is not a file named BB.MAC in the current subdirectory,
  383. Blackbeard will look in the DOS environment fo the symbol BBMAC,
  384. if it is found it will use the filename supplied with the symbol.
  385.  
  386.    To set BBMAC place this command or one similar in your
  387. autoexec.bat file
  388.  
  389.      SET BBMAC=C:\BB.MAC
  390.  
  391.    See the macros menu for the read and save macro commands.  To
  392. read in macro files with different filenames simply enter the
  393. desired file name to the read file prompt.  These commands will
  394. request a filename and default to the current path and BB.CFG
  395. filename if none is given.
  396.  
  397. Key binding File
  398.  
  399.    Blackbeard keeps a key binding file that will allow you to
  400. redefine the keystrokes: Blackbeard looks in the current
  401. subdirectory for a file named BB.KEY.  This file will be used to
  402. define the keyboard.  If there is not a file named BB.KEY in the
  403. current subdirectory, Blackbeard will look in the DOS environment
  404. for the symbol BBKEY, if it is found it will use the filename
  405. supplied with the symbol.  This will let you keep one keyboard
  406. file and use Blackbeard from any disk or directory.
  407.  
  408.    To set BBKEY place this command or one similar in your
  409. autoexec.bat file
  410.  
  411.      SET BBKEY=C:\BB.KEY
  412.  
  413.    See the OPTIONS/SETTINGS/KEYS menu for the read and save key
  414. bindings commands.  These commands will request a filename and
  415. default to the current path and BB.KEY filename if none is
  416. given.  Key binding is thoroughly discussed in a subsequent
  417. section.
  418.  
  419. Other configuration
  420.  
  421.    If you are using the IBM monochrome adapter or a
  422. color/graphics adapter with a color monitor, you will not have to
  423. configure Blackbeard for your system.  If you are using
  424. Blackbeard with a color/graphics adapter and a monochrome
  425. monitor, you will have to configure Blackbeard so that it does
  426. not use color.  To do this run Blackbeard, press αF9 (to turn off
  427. color) and save your configuration using the configuration menu.
  428.  
  429. HOW BLACKBEARD HANDLES FILES
  430.  
  431. Virtually virtual memory
  432.  
  433.    Blackbeard uses a virtually virtual memory method to handle
  434. large files.  This means it pages the file in and out of memory.
  435. The messages Reading file and Writing file appear on the status
  436. line to indicate when Blackbeard is paging the file.  Blackbeard
  437. uses to two buffers to keep track of your file.  One that keeps
  438. track of every line in the file and one that pages your file in
  439. and out.  Blackbeard's file size is limited by the number of
  440. lines.  The default is about 8000 lines (this is large enough for
  441. almost all text files).  However, you can tell Blackbeard how to
  442. allocate its vitrual memory buffers.  The line buffer's size can
  443. be scaled from 4000 to about 24000.  The default is 8000.  It
  444. should be set to the maximum expected file size (in terms of
  445. lines) you will edit.  To set the line limit run Blackbeard with
  446. either of the following commands:
  447.  
  448.    BB =# of lines or
  449.    BB <filename> =# of lines
  450.  
  451.    Example:
  452.  
  453.    BB read.me =20000
  454.  
  455.    will run Blackbeard such that it can accept files that have
  456. up to 20000 lines.
  457.  
  458. Backup
  459.  
  460.    Blackbeard can be configured to create a backup file, at
  461. startup it will copy the original to a .BAK file.  While editing,
  462. Blackbeard will page your file in and out of memory.  If the
  463. computer should crash while editing; the edited file may be
  464. unusable.  The default is not to provide a backup file.
  465.  
  466. File saving
  467.  
  468.    Blackbeard always works on the current file.  When you change
  469. to a window that contains a different file, the file in the
  470. previous window is saved and the new file is read in and you are
  471. positioned where you left off.  Every time you change to a window
  472. with a different file (or one of the three special purpose
  473. windows), Blackbeard saves the file.  This means you cannot go
  474. back to your original text.  (If automatic backup is on a backup
  475. is made when you enter a new file with the new file command).
  476.  
  477. Memory Residence
  478.  
  479.    Blackbeard can be loaded in the background and popped up (like
  480. Borland's Sidekick).  It uses up about 128k bytes of memory.  To
  481. load Blackbeard in the background execute Blackbeard with the
  482. following command:
  483.  
  484. BB =r
  485.  
  486.    You can specify a number of lines with BB =r#####
  487.  
  488.    Once Blackbeard is loaded in the background it is popped up
  489. with the file you were last editing with the ALT = (α=) key.  It
  490. will resume editing where you last left off.  Popping Blackbeard
  491. up with ALT - (α-) pops up Blackbeard and you are queried for a
  492. new filename.
  493.  
  494.    Notes about operating Blackbeard in the background:
  495.  
  496.    o  When popped up from the command prompt, the DOS window and
  497.       DOS exit commands do not work.  They work fine if it is
  498.       popped up behind another program.
  499.  
  500.    o  Beware of popping Blackbeard up behind a graphics program.
  501.  
  502.  
  503. COMMANDS
  504.  
  505.    The remainder of this document describes all the Blackbeard
  506. commands and their original key binding by categories.
  507.  
  508. CURSOR MOVEMENT
  509.  
  510.    This section defines the commands to move the cursor and
  511. window about.
  512.  
  513.    COL LEFT  (->)
  514.       Moves the cursor left one column. When the cursor reaches
  515.       the window edge, the window is scrolled.
  516.  
  517.    COL RIGHT  (<-)
  518.       Moves the cursor right one column. When the cursor reaches
  519.       the window edge, the window is scrolled.
  520.  
  521.    ROW UP  ()
  522.       Moves the cursor up one line. If the cursor is at the top
  523.       of the window, then the window moves up a line.
  524.  
  525.    ROW DOWN  ()
  526.       Moves the cursor down one line. If the cursor is at the
  527.       bottom of the window, then the window moves down a line.
  528.  
  529.    HOME  (Home)
  530.       Moves the cursor to the upper left corner of the window.
  531.  
  532.    END OF SCREEN  (End)
  533.       Moves the cursor to the lower left corner of the window.
  534.  
  535.    PAGE UP  (PgUp)
  536.       Moves the window up the length of the window.
  537.  
  538.    PAGE DOWN  (PgDn)
  539.       Moves the window down the length of the window.
  540.  
  541.    START OF FILE  (^PgUp)
  542.       Moves to the start of the file.
  543.  
  544.    END OF FILE  (^PgDn)
  545.       Moves to the end of the file.
  546.  
  547.    WORD RIGHT  (^->)
  548.       Moves the cursor a word to the right. If the next word is
  549.       not in the window, then the window is repositioned so that
  550.       the word is centered in the window.
  551.  
  552.    WORD LEFT  (^<-)
  553.       Moves the cursor a word to the left. If the next word is
  554.       not in the window, then the window is repositioned so that
  555.       the word is centered in the window.
  556.  
  557.    LEFT OF SCREEN  (^Home)
  558.       Puts the cursor at the left edge of the window.
  559.  
  560.    RIGHT OF SCREEN  (^End)
  561.       Puts the cursor at the right edge of the window.
  562.  
  563.    END OF LINE  (^E)
  564.       Places the cursor at the end of the line. This may involve
  565.       shifting the window to the right.
  566.  
  567.    GOTO  (^G)
  568.       Goto a specified line of the file. If the line is greater
  569.       than the number of lines in the file, END OF FILE is
  570.       performed.
  571.  
  572.    TAB  (->| or ^I)
  573.       If fixed tabs are on, moves right to the next tab. If
  574.       fixed tabs are off moves the cursor right tab size
  575.       columns.
  576.  
  577.    TAB LEFT  (|<- or ^O)
  578.       If fixed tabs are on, moves left to the next tab. If fixed
  579.       tabs are off moves the cursor left tab size columns.
  580.  
  581.    RETURN  (^Enter or ^J)
  582.       Shifts the window to the left edge and place the cursor in
  583.       the first column and down a line.
  584.  
  585. EDIT
  586.  
  587.    Standard editing operations are available. For deletion
  588. operations, a Kill buffer is provided. It contains about the
  589. last 25 deleted lines.
  590.  
  591.    INSERT/OVERSTRIKE  (Ins)
  592.       Toggles insert and overstrike character mode.
  593.  
  594.    DELETE CHAR  (Del)
  595.       Deletes the current character.
  596.  
  597.    DELETE LINE  (^D)
  598.       Deletes the current line to the Kill buffer.
  599.  
  600.    BACKSPACE  (Backspace or ^H)
  601.       Deletes the previous character. If the cursor is at
  602.       column one nothing happens.
  603.  
  604.    BREAK LINE  (^K - mnemonic is krack)
  605.       Breaks the line at the current cursor position.
  606.  
  607.    INSERT LINE  (^I)
  608.       Inserts a line at the current cursor positon.
  609.  
  610.    RETURN & INSERT LINE  (Enter or ^M)
  611.       Performs RETURN and INSERT LINE.
  612.  
  613.    UNDELETE LINE  (^U)
  614.       Inserts a line from the Kill buffer at the current line.
  615.       That line is deleted from the Kill buffer.
  616.  
  617.    DELETE TO EOL  (^W - mnemonic is waste)
  618.       Deletes the rest of the line. Undo will undo this function.
  619.  
  620.    YANK LINE  (^Y)
  621.       Inserts a line from the Kill buffer at the current line.
  622.       This allows multiple insertion of the same deleted line.
  623.       It works as a quick cut and paste.
  624.  
  625.    DELETE BLOCK  (αD)
  626.       Deletes a marked block.
  627.  
  628.    JOIN LINE  (αK)
  629.       Joins the next line to the current line. A space is used
  630.       to separate the lines.
  631.  
  632.    UNDO  (αU)
  633.       Restores the line to the last edited state.
  634.  
  635.    BREAK & NEXT LINE (αJ)
  636.       Breaks the current line and set cursor to next line
  637.  
  638.    SELF INSERT
  639.       Inserts the character.
  640.  
  641.    DELETE WORD  (^Backspace)
  642.       Deletes the next word.
  643.  
  644. FILE
  645.  
  646.    BACKUP FILE  (α1)
  647.       Copies the current file to a file with the same name
  648.       but with a .BAK extension.
  649.  
  650.    NEW FILE  (^N)
  651.       Opens a new file to edit in the current window. If no
  652.       filename is given, a directory is displayed in a pop-up
  653.       menu. Wildcards can be used in the filename to constrain
  654.       the directory. Select the file to edit using the standard
  655.       menu keys. Esc if you do not want to select a file.
  656.  
  657.    WRITE FILE  (αW)
  658.       Write out the file
  659.  
  660.    REREAD FILE  (αN)
  661.       Rereads the file.
  662.  
  663.    SWITCH TO FILE  (αG)
  664.       Switchs to the file under the cursor. The filename is
  665.       delimited by a non-file character.
  666.  
  667.    INSERT FILE
  668.       Will insert the specified file before the current line.
  669.  
  670. WINDOWS
  671.  
  672.    Blackbeard is a windowed editor with 13 windows; 10 for
  673. normal editing, and three for special purposes. You can edit one
  674. or more files in the general editing windows. To edit a
  675. different file in a window just bring up the window using Ctrl
  676. and one of the function (F1-F10) keys and press ^N to edit a
  677. different file. Note that this does not affect any other
  678. windows; only the current window you are in. The current file
  679. will "follow you around" to the un-initialized windows that you
  680. move to. You can select, re-size, and color windows from the
  681. window sub menu.
  682.  
  683. ┌─────────────────────────────────────────────────────────────────┐
  684. │                  Windows and their default sizes                │
  685. ├──────────────────────────────────────┬──────────────────────────┤
  686. │  ^F1 - Main window; full screen      │    αF1 - DOS window      │
  687. │  ^F2 - full screen                   │    αF3 - Paste window    │
  688. │  ^F3 - left half of screen           │    αF4 - Kill window     │
  689. │  ^F4 - right half of screen          │                          │
  690. │  ^F5 - top half of screen            │                          │
  691. │  ^F6 - bottom half of screen         │                          │
  692. │  ^F7 - left half of screen           │                          │
  693. │  ^F8 - right half of screen          │                          │
  694. │  ^F9 - full screen                   │                          │
  695. │  ^F10 - full screen                  │                          │
  696. └──────────────────────────────────────┴──────────────────────────┘
  697.  
  698.  
  699.    WINDOW 1 (^F1)
  700.       Selects window 1.
  701.  
  702.    WINDOW 2 (^F2)
  703.       Selects window 2.
  704.  
  705.    WINDOW 3 (^F3)
  706.       Selects window 3.
  707.  
  708.    WINDOW 4 (^F4)
  709.       Selects window 4.
  710.  
  711.    WINDOW 5 (^F5)
  712.       Selects window 5.
  713.  
  714.    WINDOW 6 (^F6)
  715.       Selects window 6.
  716.  
  717.    WINDOW 7 (^F7)
  718.       Selects window 7.
  719.  
  720.    WINDOW 8 (^F8)
  721.       Selects window 8.
  722.  
  723.    WINDOW 9 (^F9)
  724.       Selects window 9.
  725.  
  726.    WINDOW 10 (^F10)
  727.       Selects window 10.
  728.  
  729.    EXPAND  (αF5)
  730.       Expands the current window to a full screen.
  731.  
  732.    SELECT  (αF6)
  733.       Displays a pop-up menu of windows and their files. Select
  734.       the window desired. Esc to stay in the current window.
  735.  
  736.    MOVE/FRAME  (αF7)
  737.       Moves the current window. Frame changes the size of the
  738.       window by moving the lower right corner of the window.
  739.       Enter switches modes. Esc terminates moving/framing.
  740.  
  741.    COLOR/B&W  (αF9)
  742.       Turns color on and off.
  743.  
  744.    SELECT COLOR  (αF10)
  745.       Selects the foreground and background color of the current
  746.       window.
  747.  
  748.    KILL WINDOW  (αF4)
  749.       The kill window contains the paste buffer which has the
  750.       text you have cut out. It may be edited like any other
  751.       window.
  752.  
  753.    PASTE WINDOW  (αF3 or F10)
  754.       The paste window contains the paste buffer which has the
  755.       text you have cut out. It may be edited like any other
  756.       window.
  757.  
  758.    DOS WINDOW  (αF1)
  759.       The DOS window allows you to interact with DOS in a
  760.       windowed environment.
  761.  
  762.     ┌───────────────────────────────────────────────────────┐
  763.     │ Use caution when in the "DOS window" (αF1). All line  │
  764.     │ oriented commands such as compilers and linkers will  │
  765.     │ work OK. Some programs will trash you royal, use      │
  766.     │ the "exit to DOS" function αF2) for these.            │
  767.     └───────────────────────────────────────────────────────┘
  768.  
  769.  
  770. FIND & REPLACE
  771.    This section explains how to find strings and replace them
  772. with other strings.
  773.  
  774.    FIND  (^F)
  775.       Searches the file for a string. It searchs forward from
  776.       the current position to the end of the file. You can enter
  777.       special characters into a search string by pressing the
  778.       control key or using the Alt key and the numeric keypad.
  779.       Esc and Enter abort searching. To enter the character
  780.       code for Escape use the Alt key pad (in num lock mode)
  781.       and enter 27 (the code for escape).
  782.  
  783.    FIND & REPLACE  (^R)
  784.       Find a string and replaces one string with another. The
  785.       replacements can be conditional, meaning Blackbeard will
  786.       ask you whether you actually want to replace the string
  787.       before it replaces it. Replacements can be global, meaning
  788.       replace every occurrence of the string from the current
  789.       cursor position to the end of the file.
  790.  
  791.    REPEAT FIND  (αF)
  792.       Repeats the last search.
  793.  
  794.    REPEAT REPLACE  (αR)
  795.       Repeats the last replace.
  796.  
  797.    SEARCH REVERSE (^S)
  798.       Searchs the file for the requested string from the current
  799.       cursor position backward to the start of the file.
  800.  
  801.    REPEAT SEARCH REVERSE (αS)
  802.       Repeats the last search reverse
  803.  
  804. CUT & PASTE
  805.  
  806.    There are two types of regions: columns and ragged text. For
  807. columns, "mark start" marks the upper left corner and "mark end"
  808. marks the lower right corner of the block. For ragged text,
  809. "mark start" marks the start of a region, and "mark end" marks
  810. the end of a region. If "mark start" is pressed with the cursor
  811. position after the marked region it extends the region; the
  812. converse is true with respect to "mark end." Try it and you will
  813. get used to how it works; it works like you would expect it to.
  814.  
  815.    MARK START  (F1)
  816.       Marks the start of a region.
  817.  
  818.    MARK END  (F2)
  819.       Marks the end of a region.
  820.  
  821.    GRAB  (F3)
  822.       Copies the region to the paste buffer.
  823.  
  824.    CUT  (F4)
  825.       Cuts out the region to the paste buffer.
  826.  
  827.    SHIFT LEFT  (F5)
  828.       Shifts the selected lines left by tab size characters.
  829.  
  830.    SHIFT RIGHT  (F6)
  831.       Shifts the selected lines right by tab size characters.
  832.  
  833.    COPY  (F7)
  834.       Copys contents of paste buffer into the current file.
  835.  
  836.    PASTE  (F8)
  837.       Cuts the contents of the paste buffer into the current
  838.       file.
  839.  
  840.    UNMARK  (F9)
  841.       Resets the markers.
  842.  
  843.    PASTE WINDOW  (F10)
  844.       Selects the paste window for editing.
  845.  
  846.    CLEAR PASTE  (F9)
  847.       Empties the paste buffer.
  848.  
  849. COLUMNS
  850.  
  851.    There are two types of regions: columns and ragged text. For
  852. columns, "mark start" marks the upper left corner and "mark
  853. end" marks the lower right corner of the block. For ragged
  854. text, "mark start" marks the start of a region, and "mark end"
  855. marks the end of a region. If "mark start" is pressed with the
  856. cursor position after the marked region it extends the region;
  857. the converse is true with respect to "mark end." Try it and you
  858. will get used to how it works; it works like you would expect it
  859. to.
  860.  
  861.    MARK COL START  (F1)
  862.       Marks the upper left corner of the column.
  863.  
  864.    MARK COL END  (F2)
  865.       Marks the lower right corner of the column.
  866.  
  867.    GRAB COL  (F3)
  868.       Copies the column to the paste buffer.
  869.  
  870.    CUT COL  (F4)
  871.       Cuts the column into the paste buffer.
  872.  
  873.    REMOVE COL  (F5)
  874.       Copies the column to the paste buffer and clears the
  875.       column in the current file.
  876.  
  877.    REPLACE COL  (F6)
  878.       Overlays the paste buffer column-wise at the current
  879.       cursor position.
  880.  
  881.    COPY COL  (F7)
  882.       Inserts the paste buffer column-wise at the current
  883.       cursor positon.
  884.  
  885.    PASTE COL  (F8)
  886.       Inserts the paste buffer column-wise at the current
  887.       cursor positon and deletes it from the paste buffer
  888.  
  889.    CLEAR PASTE  (F9)
  890.       Empties the paste buffer.
  891.  
  892.    SHIFT LEFT  (F5)
  893.       Shifts the selected lines at the current column to the
  894.       left tab size columns.
  895.  
  896.    SHIFT RIGHT  (F6)
  897.       Shifts the selected lines at the current column to the
  898.       right tab size columns.
  899.  
  900.    UNMARK  (F9)
  901.       Clears the markers.
  902.  
  903.    PASTE WINDOW  (F10)
  904.       Selects the paste window for editing.
  905.  
  906. MACROS
  907.  
  908.    One of the most powerful Blackbeard features is the keystroke
  909. macro capability invoked by pressing ^V. When ^V is pressed
  910. Blackbeard starts remembering keystrokes that you press until
  911. ^V is pressed again (the number of keystrokes remembered is
  912. about 500). To reexecute this remembered sequence of keystrokes
  913. press ^X. Blackbeard allows you to name your macros; delete
  914. macros you have named; execute named macros; save the macros to
  915. a file and read them back in.
  916.  
  917.    DEFINE MACRO  (^V)
  918.       Starts and stops keystroke remembering
  919.  
  920.    EXECUTE MACRO  (^X)
  921.       Executes the current keystroke macro
  922.  
  923.    NAME MACRO  (αV)
  924.       Assigns a name to the current keystroke macro.
  925.  
  926.    WRITE MACROS
  927.       Writes the named macros to a file. If no filename is
  928.       given BB.MAC is assumed.
  929.  
  930.    READ MACROS
  931.       Reads in a macro file. If no filename is given BB.MAC is
  932.       assumed.
  933.  
  934.    EXECUTE NAMED MACRO  (αX)
  935.       A menu of named macros appears. Select the desired macro
  936.       to execute. This macro now becomes the current macro.
  937.  
  938.    DELETE MACRO  (αM)
  939.       A menu of named macros appears. Select the macro you want
  940.       to delete.
  941.  
  942. WORD PROCESSING
  943.  
  944.    This section describes the word processing functions.
  945.  
  946.    ADJUST PARAGRAPH  (^P)
  947.       Reformats from the beginning of the current line to
  948.       the next empty line or the end of the file using the
  949.       current right margin and the indention level of the
  950.       following line. This allows the first line to be a
  951.       different format than the rest of the paragraph.
  952.  
  953.    ADJUST SPECIAL  (αP)
  954.       Reformats the same as ADJUST PARAGRAPH, except when
  955.       justification is performed no spaces are inserted between
  956.       the first and second word. This is very useful for
  957.       bulletted paragraphs.
  958.  
  959.    ADJUST BLOCK
  960.       Reformats from the beginning of the current line to
  961.       the next empty line or the end of the file using the
  962.       current right margin and the indention level of the
  963.       current line.
  964.  
  965.    CENTER LINE  (αC)
  966.       Centers the line.
  967.  
  968.    TRANSPOSE  (^T)
  969.       Swaps the current character with the next character.
  970.  
  971.    CHANGE CASE  (αT)
  972.       Changes the case of the current character according to
  973.       the change case mode.
  974.  
  975.    CHANGE CASE REGION  (F10)
  976.       Changes a select region of text to the change case mode.
  977.  
  978.    BULLET  (^B)
  979.       Set an indent column for word wrap. When words are
  980.       wrapped, they will be indented to this column rather than
  981.       the 0 column or current line column.
  982.  
  983.    BULLET OFF  (αB)
  984.       Turns bullet mode off.
  985.  
  986.  
  987. OPTIONS/SETTINGS/KEYS/STATUS LINE
  988.  
  989.    The options and status line menus work a little differently
  990. than the command menu. The are toggle menus with ON shown as
  991. high intensity and OFF as normal intensity. To toggle an item use
  992. the enter key. Exit with escape.
  993.  
  994.    OPTIONS  (^A)
  995.       Brings up the options menu. It contains the following
  996.       information.
  997.  
  998.      Insert characters - select insert or overstrike
  999.                  character insertion
  1000.  
  1001.      Word wrap - words typed past the right margin (see
  1002.              SETTINGS menu) are wrapped to the next
  1003.              line.
  1004.  
  1005.      Case sensitive search - Consider (ON) or ignore (OFF)
  1006.                  case when searching for a
  1007.                  string.
  1008.  
  1009.      Auto-tab - Align the cursor to the column of the current
  1010.             line when inserting lines, deleting line, and
  1011.             word wrapping. Return when in auto-insert and
  1012.             auto-tab uses the column of the previous line
  1013.             unless the line is blank where it uses the
  1014.             last indent value.
  1015.  
  1016.      Auto-insert - Return inserts a line (ON) or simply goes
  1017.                to the next line (OFF)
  1018.  
  1019.      Fixed-tab - Interpret the tab key as increasing the
  1020.              indent level (OFF) or as jumping to fixed
  1021.              tab locations (ON) (tabs are toggled on and
  1022.              off with αI).
  1023.  
  1024.      Justify - Perform justification (by inserting extra
  1025.            spaces) when word wrapping and adjusting
  1026.            paragraphs.
  1027.  
  1028.      Display tabs - Indicates whether to perform a
  1029.             tab-to-space translation when displaying
  1030.             the file. ON means tabs are not
  1031.             translated, but displayed as the tab
  1032.             character. OFF means tabs are translated
  1033.             to the appropriate white space
  1034.  
  1035.      Auto backup - ON indicates that a backup of you file is
  1036.                written to the same filename with a .BAK
  1037.                extension when you edit the file. OFF
  1038.                means no backup is made.
  1039.  
  1040.       WRITE CONFIG
  1041.      Writes the configuration to the filename specified. If
  1042.      none is given BB.CFG is assumed.
  1043.  
  1044.       READ CONFIG
  1045.      Writes the configuration to the filename specified. If
  1046.      none is given BB.CFG is assumed.
  1047.  
  1048.       SETTINGS  (αA)
  1049.      Brings up the settings menu. It contains the following
  1050.      information.
  1051.  
  1052.      Right margin - Sets the right margin which is used for
  1053.             word wrap and paragraph reformatting.
  1054.  
  1055.      Tab size - Sets the tab size which is used for
  1056.             shifting text left or right and also used
  1057.             to move the cursor when the tab function is
  1058.             executed in non-fixed mode.
  1059.  
  1060.      Line size - Sets the size of the line for line drawing
  1061.              mode. 0 = dashed line; 1 = single width;
  1062.              2 = double width.
  1063.  
  1064.      Case mode - Set the change case mode used with change
  1065.              case and change case region. 0 = Flip case;
  1066.              1 = Upper case; 2 = Lower case
  1067.  
  1068.      Insert number - Sets the number to insert with the
  1069.              insert number function.
  1070.  
  1071.       STATUS
  1072.      Brings up the status line menu.
  1073.  
  1074.       STATUS COLOR
  1075.      Selects the foreground and background color of the
  1076.      status line.
  1077.  
  1078.  KEY BINDING
  1079.  
  1080.    Every key on the keyboard (with a few exceptions such as ^)
  1081. can be bound to function. This is done by creating a key
  1082. binding file. This file is a text file with each line having a
  1083. key name and a function name. BBKEYS.TXT is the default key
  1084. binding file. To create a compiled binding file, this text file
  1085. must be compiled with the Blackbeard compiler BBC.EXE. To
  1086. rebind keys do the following:
  1087.  
  1088.    1. Edit the key binding file using Blackbeard.
  1089.    2. Run the compiler with the following command.
  1090.  
  1091.       BBC BBKEYS.TXT
  1092.  
  1093.       The file is your text key binding file. The outputsecond
  1094.       file is the name of your compiled file.
  1095.  
  1096.    3. Run Blackbeard and use this key file by naming it bb.key
  1097.       or reading it using the read bindings command. NOTE:
  1098.       running BBC in the DOS window and reading the keybinding
  1099.       file allows you to "dynamically" rebind keys inside
  1100.       Blackbeard.
  1101.  
  1102. Commands
  1103.  
  1104.       SHOW BINDINGS  (α2)
  1105.      Displays the current key to function bindings.
  1106.  
  1107.       WRITE BINDINGS
  1108.      Writes the key bindings to the specified file. If no
  1109.      filename is given BB.KEY is used.
  1110.  
  1111.       READ BINDINGS
  1112.      Read the key bindings from the specified file. If no
  1113.      filename is given BB.KEY is used.
  1114.  
  1115. MISCELLANEOUS
  1116.    There are many miscellaneous functions to satisfy specialized
  1117. needs. This section describes these functions.
  1118.  
  1119.       NULL
  1120.      This function does nothing.
  1121.  
  1122.       MENUS  (Esc)
  1123.      Calls up the command menus.
  1124.  
  1125.       REPEAT MENU COMMAND  (αE)
  1126.      Repeats the last menu command. This key is bound to
  1127.      one of the mouse buttons.
  1128.  
  1129.       EXIT  (^Z)
  1130.      Saves the file and exits Blackbeard
  1131.  
  1132.       ABORT  (αZ)
  1133.      Exits Blackbeard without saving the current file.
  1134.      Useful if you selected a strange file to edit or want
  1135.      to start over.
  1136.  
  1137.       EXIT TO DOS  (αF2)
  1138.      Saves the file; keeps Blackbeard memory resident and
  1139.      returns to DOS. To return to Blackbeard type EXIT at
  1140.      the DOS prompt.
  1141.  
  1142.       REPEAT KEY (α4)
  1143.      Repeats a key a selected number of times. You are
  1144.      prompted for the repeat count and then the key to
  1145.      repeat. If you want to interrupt repeat hit any key.
  1146.  
  1147.       TAB TOGGLE  (αI)
  1148.      Sets and resets a tab stop in fixed tab mode.
  1149.  
  1150.       ASCII CHART  (^C)
  1151.      Displays an ascii chart with DECIMAL, HEX and
  1152.      Character. Scroll the chart with the left, right, up
  1153.      and down arrows. Esc to exit.
  1154.  
  1155.       INSERT SPECIAL CHAR  (^Q)
  1156.      Inserts any ascii character specified by number. If no
  1157.      value is input the character 0 or NUL is inserted.
  1158.      This is very useful for putting in special printer
  1159.      escape sequences. The ALT key and the numeric keypad
  1160.      can also perform this function for certain characters,
  1161.      but not the Ctrl keys.
  1162.  
  1163.       LAST DOS COMMAND  (αL)
  1164.      Displays the last DOS command executed in the DOS
  1165.      window.
  1166.  
  1167.       LINE DRAWING  (αQ)
  1168.      BLACKBEARD has a line drawing capability which can be
  1169.      used to make boxes, organization charts, and other line
  1170.      oriented pictures. It is not a true graphics feature,
  1171.      but instead uses the IBM PC line characters. You can
  1172.      think of the line drawing as a crude pen plotter. Press
  1173.      αQ to drop the pen (the αQ is really a toggle, which
  1174.      raises or loweres the pen). At this point, any cursor
  1175.      movements using the cursor keys will cause a line to
  1176.      be drawn. You can use the four arrow keys to move left,
  1177.      right, up, and down. In addition, you can use the four
  1178.      corner keys (1,3,7,9) to move along a diagonal, but the
  1179.      diagonal lines are not as well formed as the horizontal
  1180.      and vertical line. Here is a sample picture :
  1181.  
  1182.             ┌───────────┐        ┌─────────────┐
  1183.             │ Box 1     ├────────┤  Box 2      │
  1184.             │           │        │             │
  1185.             └───────────┘        └─────────────┘
  1186.  
  1187.         The boxes are formed by dropping the pen (αQ),
  1188.      moving the cursor, and then lifting the pen (αQ
  1189.      again).
  1190.  
  1191.         The line drawing characters will only print on
  1192.      printers which support the IBM PC character set (such
  1193.      as the IBM Graphics printer, the STAR SG-10, and some
  1194.      EPSONS). If you do not have one of the correct
  1195.      printers, you can still do some line drawing using a
  1196.      different line width. BLACKBEARD supports three line
  1197.      widths: 0, 1, and 2. The picture above is using line
  1198.      width 1, while this (═══════) is line width 2. Most
  1199.      printers actually print the line width 2 as line
  1200.      width 1. If this is true of your printer, then line
  1201.      width 2 is useful mainly for on screen text. Line width
  1202.      0 is used to draw lines using the standard ASCII
  1203.      characters. The characters are hyphens (---) for
  1204.      horizontal lines, bars (|) for vertical lines, and
  1205.      plus (+) for corner connectors. Here is a line width 0
  1206.      box :
  1207.  
  1208.            +-----------+     +-----------+
  1209.            |           |     |           |
  1210.            | Line 0    +-----+  Boxes    |
  1211.            |           |     |           |
  1212.            +-----------+     +-----------+
  1213.  
  1214.         These will print on nearly any printer.
  1215.  
  1216.      A few tips for using boxes. A good way is to build your
  1217.      boxes, and then fill them with text with insert mode
  1218.      off. This is done using the INS key to toggle insert
  1219.      mode. The flags on the bottom status line show an I for
  1220.      insert mode. Insert mode is turned off when the I is
  1221.      not visible.
  1222.  
  1223. THE MOUSE
  1224.    A mouse is a productive device for cursor movement and
  1225. command selection. The mouse makes interaction with the screen
  1226. simpler, faster, and more spontaneous.
  1227.  
  1228.    Moving the mouse is as natural as moving your hand. As you
  1229. move the mouse, the cursor moves on the screen.
  1230.  
  1231.    The right button on the mouse is used to call up the menu.
  1232. The left button is used to select items. When the mouse menu is
  1233. requested, it is placed at the cursor location, which is your
  1234. eye's focal point. The menu is the inverse color of the current
  1235. window. The menu item currently selected is the color of the
  1236. current window.
  1237.  
  1238.    When the cursor is positioned over a menu item, pressing the
  1239. left button selects a command.
  1240.  
  1241.    The right button on the mouse is used to "escape" from the
  1242. menu without selecting an item. This button is also used to
  1243. return to the main mouse menu from within a sub-menu.
  1244.  
  1245.    Blackbeard now includes an INTEGRAL MOUSE DRIVER for the
  1246. Microsoft Mouse. The mouse will be automatically available if
  1247. the Mouse driver is loaded. These buttons correspond to
  1248. Blackbeard commands.
  1249.  
  1250. Mouse
  1251. Button      Key         Typical function
  1252. Left        Enter or    RETURN & INSERT LINE
  1253.         ^M
  1254.  
  1255. Right       Esc         MENUS
  1256.  
  1257.    Mouse movements are tranlsated into cursor movements; the
  1258. left button is translated to enter and used to select menu
  1259. items; the right button is translated to escape and used to
  1260. pop-up and exit menus.
  1261.  
  1262. Mouse Systems
  1263.  
  1264.    The Blackbeard distribution diskette includes a mouse menu
  1265. driver for the Mouse Systems Mouse. To use the mouse install the
  1266. PC mouse menu driver by running MOUSESYS (this is described in
  1267. your Mouse Systems Manual). Run the Blackbeard menu program with
  1268. the following command:
  1269.  
  1270.       M_BB
  1271.  
  1272.    This will install a mouse driver for Blackbeard.  Mouse
  1273. movements are tranlsated into cursor movements; the left button
  1274. is translated to enter and used to select menu items; the right
  1275. button is translated to escape and used to pop-up and exit menus;
  1276. the middle button and pressing the left and right buttons
  1277. simultaneously will repeat the last menu command.
  1278.  
  1279.